eng-service API

eng-service supports 8 commands: Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index

/epe/eng/lastrssi    POST version Input: Output:
Description: Shows the last RSSI signal packet (before normalization) that the tag has reported. Remembers a single packet per tag.

Signal packets are only stored if there is an active model.

Role Required: viewer
Call Counter: Total: 5, Failed: 0

tagid (optional) - [long] device id
mac (optional) - [String] device MAC address
sort (optional) - [String] sort by: 'rssi' (the only available at the moment)
RSSIDATA.ap - [Array] access point MAC addresses
RSSIDATA.channel - [Array] channel numbers
RSSIDATA.rssi - [Array] signal strengths
RSSIDATA.scantime - [Array] relative scantimes in milliseconds
RSSIDATA.modelap - [Array] mapped access point MAC addresses
RSSIDATA.modelmyap - [Array] a subset of modelap; only contains MAC addresses enabled in the model ("my APs")
RSSIDATA.timestamp - [long] timestamp in milliseconds
RSSIDATA.scanreason - [int] scan reason, one of the following: 1=Button, 2=Motion, 3=Periodic, 4=Calibrate, 5=After motion, 6=Button2, 7=Tamper alarm, 8=Button3, 9=Charger status, 10=Safety switch status, 11=Low battery, 12=Motion stagnant, 13=Menu selection, 14=Supplementary, 15=Location beacon, 16=Priority message ack, 17=Battery level changed, 20=Network
RSSIDATA.mac - [String] device MAC address
RSSIDATA.scannedchannels - [int] scanned channels bitmask
RSSIDATA.measurementmethod - [String] what kind of RSSI measument was used: ACTIVE = measurement was done by the tag itself; ARUBA_BLINK = tag has sent a blink frame which is measured by Aruba APs; CISCO_BLINK = similar to ARUBA_BLINK, but using Cisco infrastructure; TZSP_BLINK = tag blink measured by Tzsp APs; MERU_BLINK = tag blink measured by Meru APs
RSSIDATA.tagid - [long] tag id
RSSIDATA.irid - [Array] IR beacon IDs
RSSIDATA.irtime - [Array] relative IR detection time in milliseconds
RSSIDATA.irinmodel - [Array] array of strings, either "TRUE" or "FALSE" depending on whether the IR beacon is defined in the active model or not
/epe/eng/locationbeacondelete    POST version Input: Output:
Description: Deletes a location beacon

Role Required: poweruser
Call Counter: Total: 0, Failed: 0

locationbeaconid (required) - [Array] id of the location beacon to be deleted
/epe/eng/locationbeaconlist    POST version Input: Output:
Description: Lists location beacons

Role Required: viewer
Call Counter: Total: 0, Failed: 0

locationbeaconid (optional) - [long] id of the location beacon
identifier (optional) - [String] unique beacon identifier
LOCATIONBEACON.locationbeaconid - [long] id of the location beacon
LOCATIONBEACON.identifier - [String] unique beacon identifier, like 11AA22
LOCATIONBEACON.battery - [int] battery level of the location beacon (optional)
LOCATIONBEACON.updatedtime - [long] when battery level was last time updated in milliseconds since January 1, 1970, 00:00:00 GMT (optional)
LOCATIONBEACON.updatedtimestamp - [String] when battery level was last time updated in server local time in ISO 8601 (yyyy-MM-dd HH:mm:ss) format (optional)
LOCATIONBEACON.modelid - [long] id of the model for the position data
LOCATIONBEACON.mapid - [long] id of the map where the location beacon is defined in model or detected (if not in model)
LOCATIONBEACON.mapname - [long] name of the map where the location beacon is defined in model or detected (if not in model)
LOCATIONBEACON.zoneid - [long] id of the zone where the location beacon is defined in model or detected (if not in model)
LOCATIONBEACON.zonename - [long] name of the zone where the location beacon is defined in model or detected (if not in model)
LOCATIONBEACON.x - [long] x coordinate on the map where the location beacon is defined in model or detected (if not in model)
LOCATIONBEACON.y - [long] y coordinate on the map where the location beacon is defined in model or detected (if not in model)
LOCATIONBEACON.activemodelcontains - [String] true if the the beacon is defined in the currently active model, false if not in the active model
/epe/eng/normalizationbrowse    POST version Input: Output:
Description: Show signal normalization configuration. Normalization file can also be downloaded with filedownload command.

Example 1: Show configuration
/epe/eng/normalizationbrowse

Role Required: viewer
Call Counter: Total: 5, Failed: 0

tagid (optional) - [long] return normalization info for this tag, if available
mac (optional) - [String] alternative to tagid
NORMALIZATION.version - [String] normalization config version
NORMALIZATION.revision - [String] normalization config revision
DEVICE.vendor - [String] vendor
DEVICE.chipset - [String] chipset
DEVICE.revision - [String] revision
DEVICE.type - [int] normalization device type id
DEVICE.description - [String] device description
DEVICE.normalization - [String] normalization function source, either GENERIC or SITESPECIFIC
/epe/eng/tagsetpos    POST version Input: Output:
Description: Sets the location for the sensor tags

Role Required: viewer
Call Counter: Total: 0, Failed: 0

mapid (required) - [long] map id
x (required) - [int] X coordinate
y (required) - [int] Y coordinate
tagid (optional) - [long] device id
mac (optional) - [String] device MAC address
/epe/eng/_clear Input: Output:
Description: SPECIAL. Resets all service specific counters.

Role Required: poweruser
Call Counter: Total: 0, Failed: 0

/epe/eng/_list    POST version Input: Output:
Description: SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions.

Role Required:
Call Counter: Total: 1, Failed: 0

help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.
COMMAND.name - [String] command name
COMMAND.arg - [String] mandatory argument
COMMAND.optarg - [String] optional argument
COMMAND.response - [String] response field
COMMAND.internal - [int] 1 for internal command
COMMAND.role - [String] required role
COMMAND.callcount - [int] number of calls
COMMAND.callcountinternal - [int] number of internal calls
COMMAND.callcountfailure - [int] number of failed calls
COMMAND.htmlhelp - [String] command description in HTML format
/epe/eng/_status Input: Output:
Description: SPECIAL. Returns status information about the service.

Role Required: viewer
Call Counter: Total: 6, Failed: 0

STATUS.callcount - [int] total number of calls for the service
STATUS.callcountinternal - [int] total number of internal calls for the service
STATUS.callcountfailure - [int] total number of failed calls for the service
STATUS.commandcount - [int] number of commands in service
STATUS.* - [String] service specific status information

(The data in this page was generated from /epe/eng/_list?help=1)